ParticipantOrganizationUniversal Tabular View
| COCD_TP000029GB01 | |||||||||||
| ParticipantRole |
Identifies the organisation as a participant. In circumstances where an explicit template for the participation is available (for example one that describes an author), then that explicit template must be used instead of this template. |
||||||||||
| Used by: | |||||||||||
| [1..1] [M] classCode (CS { CNE: RoleClass } ) { Fixed="ROL" } |
Model Attribute Description The HL7 attribute classCode describes this class as a role. This is a generic code and the type of role should be described using the HL7 attribute code whenever possible. Implementation in XML Instance
|
||||||||||
| [0..1] addr (AD) |
Model Attribute Description The HL7 attribute addr provides a contact address for the organisation which is the site where the role is based. The HL7 attribute addr allows structured and unstructured addresses to be carried in an instance. Only structured addresses are recommended to be used. There are a number of structured forms of addresses. The three shown here are the recommended formats for organisation addresses, they are listed in no particular order. Implementation in XML Instance When the structured address in the style of PDS is used then it shall contain five XML elements streetAddressLine.
The first XML element streetAddressLine or second XML element streetAddressLine and the fourth XML element streetAddressLine are mandated to be populated.
or the address may use the fully structured address
Alternatively the structured address may contain just a series of XML elements streetAddressLine populated in the correct order to render as a postal address with as much information as available included.
The XML element addr allows an XML attribute use, this should be used to further define the organisation address when required. Only the use values listed below are recommended to be used for organisation addresses.
The XML element useablePeriod of XML element addr can be used to indicate some of the following types of valid times:
|
||||||||||
| [0..1] code (CV { CWE:RoleCode } ) |
Model Attribute Description
The HL7 attribute code uses a code from any available vocabulary to describe the organisation role. Implementation in XML Instance The Coded Plain flavour of the Coded Value (CV) data type shall be used to carry this information in the XML element code as follows: When the RoleCode vocabulary is used then:
When an alternative vocabulary is used and no OID is available then:
|
||||||||||
| [0..*] telecom (SET<TEL>) |
Model Attribute Description The HL7 attribute telecom provides contact details for the organisation playing the role in the form of telephone numbers, fax numbers and email addresses. Implementation in XML Instance This XML element telecom should be populated as below: The XML attribute value of the XML element telecom should contain the telephone / fax number or an email address prefixed by the type of contact and a colon.
The XML attribute use of the XML element telecom may be used to give further information about the type of contact details contained in the XML attribute value. Only the use values listed below are recommended for the contact details associated with the role:
The XML element useablePeriod of XML element telecom may be used to indicate when the contact details given are valid, for example to indicate that a telephone number is only for office hours (9am to 5 pm). It can be used to indicate some of the following types of valid times:
|
||||||||||
| [1..1] [M] templateId (II) { Fixed="COCD_TP000029GB01#ParticipantRole" } |
Model Attribute Description Implementation in XML Instance The Identifier External data type flavour is used to carry this information in the XML element templateId as follows:
|
||||||||||
| [1..1] [M] scopingOrganization (Organization) |
A link to the organisation scoping this role.
|
||||||||||
| Organization |
This class details the organisation which scopes the role (the organisation as the participant). |
||||||||||
| Used by: ParticipantRole | |||||||||||
| [1..1] [M] classCode (CS { CNE: EntityClass } ) { Fixed="ORG" } |
Model Attribute Description The HL7 attribute classCode describes this class as an organisation. Implementation in XML Instance
|
||||||||||
| [1..1] [M] determinerCode (CS { CNE: EntityDeterminer } ) { Fixed="INSTANCE" } |
Model Attribute Description The HL7 attribute determinerCode describes this class as an instance of an organisation. Implementation in XML Instance
|
||||||||||
| [1..1] [M] desc (ST) |
Model Attribute Description The HL7 attribute desc uses the description of the organisation associated with the ODS code. Implementation in XML Instance
The XML element
desc will carry the description associated with the ODS code carried in the XML attribute
extension of the XML element
id.
|
||||||||||
| [1..1] [M] id (II) |
Model Attribute Description The HL7 attribute id uses an ODS code as an identifier that uniquely identifies the organisation in the role. The ODS code should identify the organisation at either the site level or organisation level. Where possible the organisation should be identified at the site level. ODS codes were formerly known as NACS codes. Implementation in XML Instance When ODS site code is used then the XML element id is populated in the following way:
When ODS organisation code is used then the XML element id is populated in the following way:
|
||||||||||
| [1..1] [M] templateId (II) { Fixed="COCD_TP000029GB01#scopingOrganization" } |
Model Attribute Description Implementation in XML Instance The Identifier External data type flavour is used to carry this information in the XML element templateId as follows:
|